Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(thanos): add migration doc for thanos storage clients #16133

Merged
merged 11 commits into from
Feb 11, 2025
Merged

docs(thanos): add migration doc for thanos storage clients #16133

merged 11 commits into from
Feb 11, 2025
+315 −1

Conversation

ashwanthgoli
Copy link
Contributor

What this PR does / why we need it:

Adds a migration doc to enable Thanos storage clients. These will replace the existing storage clients in a future release.
I have documented the configuration changes required to migrate clients for commonly used storage backends such as gcs, s3 and azure.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@ashwanthgoli ashwanthgoli requested a review from a team as a code owner February 6, 2025 13:50
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Feb 6, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
edited
Loading

💻 Deploy preview deleted.

JStickler
JStickler reviewed Feb 6, 2025
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] Nice job. I added a couple of links, and made some suggestions for revisions, but overall this looks good.

docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
JStickler
JStickler reviewed Feb 7, 2025
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] Thanks for adding examples, users are always asking for more examples.

docs/sources/configure/examples/thanos-storage-configs.md Outdated Show resolved Hide resolved
docs/sources/configure/examples/thanos-storage-configs.md Show resolved Hide resolved
docs/sources/configure/examples/thanos-storage-configs.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/migrate/migrate-storage-clients/_index.md Outdated Show resolved Hide resolved
JStickler
JStickler approved these changes Feb 11, 2025
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM.

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Feb 11, 2025

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit b63c191 into main Feb 11, 2025
62 checks passed
@JStickler JStickler deleted the thanos-migration-doc branch February 11, 2025 13:25
loki-gh-app bot pushed a commit that referenced this pull request Feb 11, 2025
@ashwanthgoli @grafana-delivery-bot
docs(thanos): add migration doc for thanos storage clients (#16133)
ebb429d 
Signed-off-by: Ashwanth <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit b63c191)
@loki-gh-app loki-gh-app bot mentioned this pull request Feb 11, 2025
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JStickler JStickler JStickler approved these changes

Assignees
No one assigned
Labels
backport k239 size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ashwanthgoli @JStickler